[![](https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white)](https://github.com/H-IAAC/Github-Index)

# Github Index

Util functions for generating a Sphinx page with a index of repositories in Github.


This project was developed as part of the Cognitive Architectures research line from 
the Hub for Artificial Intelligence and Cognitive Architectures (H.IAAC) of the State University of Campinas (UNICAMP).
See more projects from the group [here](https://h-iaac.github.io/HIAAC-Index).

<!--Badges-->
[![](https://img.shields.io/badge/-H.IAAC-eb901a?style=for-the-badge&labelColor=black)](https://hiaac.unicamp.br/)


<!--Meta 1: Arquiteturas Cognitivas-->
[![](https://img.shields.io/badge/-Arq.Cog-black?style=for-the-badge&labelColor=white&logo=data:image/svg%2bxml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4gPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI1Ni4wMDQiIGhlaWdodD0iNTYiIHZpZXdCb3g9IjAgMCA1Ni4wMDQgNTYiPjxwYXRoIGlkPSJhcnFjb2ctMiIgZD0iTTk1NS43NzQsMjc0LjJhNi41Nyw2LjU3LDAsMCwxLTYuNTItNmwtLjA5MS0xLjE0NS04LjEtMi41LS42ODksMS4xMjNhNi41NCw2LjU0LDAsMCwxLTExLjEzNi4wMjEsNi41Niw2LjU2LDAsMCwxLDEuMzY4LTguNDQxbC44LS42NjUtMi4xNS05LjQ5MS0xLjIxNy0uMTJhNi42NTUsNi42NTUsMCwwLDEtMi41OS0uODIyLDYuNTI4LDYuNTI4LDAsMCwxLTIuNDQzLTguOSw2LjU1Niw2LjU1NiwwLDAsMSw1LjctMy4zLDYuNDU2LDYuNDU2LDAsMCwxLDIuNDU4LjQ4M2wxLC40MSw2Ljg2Ny02LjM2Ni0uNDg4LTEuMTA3YTYuNTMsNi41MywwLDAsMSw1Ljk3OC05LjE3Niw2LjU3NSw2LjU3NSwwLDAsMSw2LjUxOCw2LjAxNmwuMDkyLDEuMTQ1LDguMDg3LDIuNS42ODktMS4xMjJhNi41MzUsNi41MzUsMCwxLDEsOS4yODksOC43ODZsLS45NDcuNjUyLDIuMDk1LDkuMjE4LDEuMzQzLjAxM2E2LjUwNyw2LjUwNywwLDAsMSw1LjYwOSw5LjcyMSw2LjU2MSw2LjU2MSwwLDAsMS01LjcsMy4zMWgwYTYuNCw2LjQsMCwwLDEtMi45ODctLjczMmwtMS4wNjEtLjU1LTYuNjgsNi4xOTIuNjM0LDEuMTU5YTYuNTM1LDYuNTM1LDAsMCwxLTUuNzI1LDkuNjkxWm0wLTExLjQ2MWE0Ljk1LDQuOTUsMCwxLDAsNC45NTIsNC45NUE0Ljk1Nyw0Ljk1NywwLDAsMCw5NTUuNzc0LDI2Mi43MzlaTTkzNC44LDI1Ny4zMjVhNC45NTIsNC45NTIsMCwxLDAsNC4yMjEsMi4zNDVBNC45Myw0LjkzLDAsMCwwLDkzNC44LDI1Ny4zMjVabS0uMDIyLTEuNThhNi41MTQsNi41MTQsMCwwLDEsNi41NDksNi4xTDk0MS40LDI2M2w4LjA2MSwyLjUuNjg0LTEuMTQ1YTYuNTkxLDYuNTkxLDAsMCwxLDUuNjI0LTMuMjA2LDYuNDQ4LDYuNDQ4LDAsMCwxLDIuODQ0LjY1bDEuMDQ5LjUxOSw2LjczNC02LjI1MS0uNTkzLTEuMTQ1YTYuNTI1LDYuNTI1LDAsMCwxLC4xMTUtNi4yMjksNi42MTgsNi42MTgsMCwwLDEsMS45NjYtMi4xMzRsLjk0NC0uNjUyLTIuMDkzLTkuMjIyLTEuMzM2LS4wMThhNi41MjEsNi41MjEsMCwwLDEtNi40MjktNi4xbC0uMDc3LTEuMTY1LTguMDc0LTIuNS0uNjg0LDEuMTQ4YTYuNTM0LDYuNTM0LDAsMCwxLTguOTY2LDIuMjY0bC0xLjA5MS0uNjUyLTYuNjE3LDYuMTMxLjc1MSwxLjE5MmE2LjUxOCw2LjUxOCwwLDAsMS0yLjMsOS4xNjRsLTEuMS42MTksMi4wNiw5LjA4NywxLjQ1MS0uMUM5MzQuNDc1LDI1NS43NSw5MzQuNjI2LDI1NS43NDQsOTM0Ljc3OSwyNTUuNzQ0Wm0zNi44NDQtOC43NjJhNC45NzcsNC45NzcsMCwwLDAtNC4zMTYsMi41LDQuODg5LDQuODg5LDAsMCwwLS40NjQsMy43NjIsNC45NDgsNC45NDgsMCwxLDAsNC43NzktNi4yNjZaTTkyOC43LDIzNS41MzNhNC45NzksNC45NzksMCwwLDAtNC4zMTcsMi41LDQuOTQ4LDQuOTQ4LDAsMCwwLDQuMjkxLDcuMzkxLDQuOTc1LDQuOTc1LDAsMCwwLDQuMzE2LTIuNSw0Ljg4Miw0Ljg4MiwwLDAsMCwuNDY0LTMuNzYxLDQuOTQsNC45NCwwLDAsMC00Ljc1NC0zLjYzWm0zNi43NzYtMTAuMzQ2YTQuOTUsNC45NSwwLDEsMCw0LjIyMiwyLjM0NUE0LjkyMyw0LjkyMywwLDAsMCw5NjUuNDc5LDIyNS4xODdabS0yMC45NTItNS40MTVhNC45NTEsNC45NTEsMCwxLDAsNC45NTEsNC45NTFBNC45NTcsNC45NTcsMCwwLDAsOTQ0LjUyNywyMTkuNzcyWiIgdHJhbnNmb3JtPSJ0cmFuc2xhdGUoLTkyMi4xNDMgLTIxOC4yKSIgZmlsbD0iIzgzMDNmZiI+PC9wYXRoPjwvc3ZnPiA=)](https://h-iaac.github.io/HIAAC-Index)
[![](https://img.shields.io/badge/-MANAGEMENT-black?style=for-the-badge&labelColor=white&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADEAAAA0CAYAAAAjUdCvAAAACXBIWXMAAATkAAAE5AGu5PUXAAAAGXRFWHRTb2Z0d2FyZQB3d3cuaW5rc2NhcGUub3Jnm+48GgAACQdJREFUaN7VWmeMVFUUfs7MIiIqAnbBig07dkVsxIhYEZRFYteg2GhqiAq7sxQRNEQUsGEAQxFREQMahKiIgooKiiAioQpSlmKk7O7x++47A7Oz97zdYWeN/ri5M+/ed+89/TvnvkBEgszWK5BEQVzeKYzLzb7x/1ozB5JxeR1ErO4byIH/WyL6BXIAiFiJNjSbBSnFwkCa9E7I5Xi3NZjRln1hQq7A2PEc/9eIUGncigOU8QDWnEGB7IM5N6INLozJj+i3o0lE2455c7Hmi1j/usGB7F2jRLBh0/cLErIQHKyd/rwoT87EIV7FeDFaCdo3mDcAtpRfkCfN+gRyEN6pkyIUvxsm8+QcjoOAQSDkO7xTirYB6wwrqiWn1hgR2LwxNtqMjQtSh8f/SU5C4HwyJo9hzsF7sjneOxxrdAXxP7n1yLBaclrOiXDSiMnDTg3yZKRyfRZaK4zulRO9xjpULaw5G20nJQUC6+aUCKoH1OBvboD+7pwdvqJkYtjjHrQ/Qcgv2PeMnBABDrUvJAEJ+Qr9joKYdK5pl1kUyGHY91PuC6a1qxYRUKOHaHzQ2YHjAomjL6R9JANpFMHNhnCvLd27MXkaxPdjD+IfxO+rMF6/KoRwP+cAuD/e3SMiVKxlMNwnU8/oDrHwz3g+uZy0AjkCB33Kuc7Q49CVrgPRC9RrsV+vz0sx71u07iDo0Eo1AfvzHE6NsyGiKC7XOgOLybMVFk3IpY44BDF6F3WzjA3r8HsIDRTutYFvXbpdjN/AAKpEbcP/VyojBkzozfP0jss1VSICXD2KvhvttQgpDUfblKRqxeU3Sg0HqZWN3lOq4O79eHepxpr7KrHNN0m4T5V93mEmJPBDZnBLm1MbcyY41UjIXGteFh6pDjjdX9VwtBXBHTKIyTzM+YznNInApAecB6olTY0N62J8ulOFhPSiWsGIr8yFR3LOIC4b0aYNCGRfr1ohELrzxeVeLxFEq3q453wLDAskDyKdgjl/pCACfk/E/EXkUnrg2lNC9JBrcMiPuJ9hHwMxZy0YWq8CEfACz9A4+weyn9cOQne3GbDj7HR/Tu5h4SKVVD3iI87Bet0I8jA+0vWAF4QslXojvI93thCHGdqwv2N2THqWI4J6SQJ83ihN1HRz+RU4Q/8Pz9EXUZ2EJrlO6EoJ478gHtJ+FZ/TEWCdOxkHIoy4Y5SqEsdRYikNCA8Sl9vpJn2ukV6HKBbj4yOgwmww4K8kcRXUK11a6WpG+EKXSr1GmxMVNHGmdxmTfGpFwKm2kb+LCCz8MT1ORNDbRjSbGVHxXoeihHRVl8wgtpjZYKWAMpATNfdYDfs63WDO0Rp/7jLONQlEfOiIoA0osGtniI4ReriR/RGmb1X12ZoM4bQwgldGiO47De/8TqhipsgxmW9IKp9E0pORolbUP99CEP/5PBT6s4yFPnCqFpNO2HBbWvZ2SxVjRH3MXUzVMdDzubp/M0OlaDct6bKKTGoxxkN6uZSQSzTgudSVaoH/S9ymcINZxgfBehcZarM4lZB5zreAY6EBxWWMscBMtJeNsXGEy5nur4CxIy5fqhEPwf8Z7KPcK6Mw2lhDpYZx3HhvPM/BKD2fAMvnTVxaCsP24R6OEft4vVB8Vwa4Q9WLfQldqwH5OxGL+fAXozOxlaUpePf7wEVID15HIDtEVaOFL9NzhwvkOJ9XybCP9FbBy6m3asJxn2uGulzGMSJgT4zqTA9HIujfO3rdIInwJO54fj2NygfWUvjLR0SSzzFuSJaerXUFZoa2RoY18ajaHfSKPFAJ60sGjiEHTvC83IFcNUTM7M+UBMcN/d7mQwTc32Km1sV28uVNvqwJYj/Wcq9MMznGKqFn4bbJ0B58RJT43K+CT/EV6ahiKoljjEBczB8rIOJHjWBU5kozhg4DrJ3nVQ1AD5cZlidgJ0DhQp8KYp0LLBvTLLPMV8LBuR/H2DISMQsifsEQ8Qps3MWI5Iss/017SoYJTIr7QpjhU01dqw+k96vhuQhrlhvnG0xwyR8jiN+NSRMtTKXZ2DIrsyNww5yLiX3YW/mB1nKXY07fbM+A51MJTZhHdGGi40tm1IVt9KmAuuAteL9HdTI6VyVBzPGVQjUVLmb5x4hja1lG3eXzIepTfEUs9V5tjAM8QRBGTu9RJpeQ5lol725Ea14L7PRVQ1Kul1XCsEgVZkpdDZD3HvXOqqFq0YA1puZZEtCiMEygxlkprdZ8Jxr1qB6apsZSk4ey8GWki85zWDUfzQrHK0d7psr5UdUNTYWZK4wtl5+XJ6C1yyaBZA0tYD7y0u7MLjRAL+TVBcfQe5gHZFWbOTVijktLE/K83gw1pmtkz1RTk/xVbh4lb0iAOYLWs0ZH5OGERBeWKxQwXbSQpLtHYKU6Lm9EcZn4BodPaiJVIdjxHoIR24eDMpj2FlWFNmmMT+AlTYoJ6UbUhimmdWOjQae0qt6IB2BSRTVkbx3IcBYllvqqQZfivDdVKNlowv81i2OWmNXlssjcrSZK+mqsZWYVPHQkzD1mpZ/RB7FLrORcN3pES47Dq1vCTA94euVcGnX/oblFSSae80GAfi75D+TkiLoQK9sbmB5Wt4zJ9FRLQut9UDwNVTdl2pAq1EUSQXjA9JLGaZXotXreSGMIjXY6S/oWtPDVspQRM/T9CXh2ZITDaMDrL8z73HcPbt5qspRCYqzibkbQmqoqxuA1lqgYHL7aqSeQKXv+53MGN+U6jXNKZUGS+2vQW2LdY0QXuJC6kpCqXFG5q2Je5wJM0j0a+QSfTyZei6r+lZNASMAaCwFXfmcXErLU3TPjdza67hIdlQL7bL8RoU3S5qgRUQRU7faU93Fxd3O62ZeL10RjVUQri7Oo2jm5x6Yhpm4y0T4BZ06qicOT+yxtun0AXarqKLLjEMua4TcZjCWjqvM9hicKv+3Wxc0q98n5ZxGeanj7wt3p52wXALO0GUpTvdUcTV/nQY1uy7yPqxEi0mGKftM0QtErCVrBcjtVgRkXIywTG9fzf4hiJ+sFDOcX81aU61TnmixX32QkCIv14nyUcndlGnHFrqoSPh9FkMc8JVcfcP0D91xiy4lSK94AAAAASUVORK5CYII=
)](https://h-iaac.github.io/HIAAC-Index)


## Repository Structure

- src: github_index source code


## Requirements

- Python
- Other dependencies are automatically installed with pip

## Installation

- Installing using pip:

    ```bash
    pip install --upgrade pip
    pip install github_index
    ```

- For installing from the repository:

    ```bash
    git clone https://github.com/H-IAAC/Github-Index
    cd Github-Index
    pip install --upgrade pip
    pip install .
    ```

- [HIAAC-Index](https://github.com/H-IAAC/HIAAC-Index) is a example of how to use this project

## Citation

<!--Don't remove the following tags, it's used for placing the generated citation from the CFF file-->
<!--CITATION START-->
```bibtext
@software{my_citation,
author = {Cardoso do Nascimento, Elton},
title = {Github Index},
url = {https://github.com/H-IAAC/Github-Index}
}
```
<!--CITATION END-->

## Authors

- (2025- ) [Elton Cardoso do Nascimento](https://github.com/EltonCN): M. Eng. student, FEEC-UNICAMP
  
## Acknowledgements

Project supported by the brazilian Ministry of Science, Technology and Innovations, with resources from Law No. 8,248, of October 23, 1991